home *** CD-ROM | disk | FTP | other *** search
/ TeX 1995 July / TeX CD-ROM July 1995 (Disc 1)(Walnut Creek)(1995).ISO / tex-k / tex-eplain-archive / 000009_kb@cs.umb.edu_Sat Apr 16 12:21:34 1994.msg < prev    next >
Internet Message Format  |  1995-01-08  |  21KB
  1. Received: from terminus.cs.umb.edu by cs.umb.edu with SMTP id AA25130
  2.   (5.65c/IDA-1.4.4 for <tex-eplain-exp@cs.umb.edu>); Sat, 16 Apr 1994 16:21:35 -0400
  3. Received: by terminus.cs.umb.edu id AA29542
  4.   (5.65c/IDA-1.4.4 for tex-eplain); Sat, 16 Apr 1994 16:21:34 -0400
  5. Date: Sat, 16 Apr 1994 16:21:34 -0400
  6. From: "K. Berry" <kb@cs.umb.edu>
  7. Message-Id: <199404162021.AA29542@terminus.cs.umb.edu>
  8. To: tex-eplain@cs.umb.edu
  9. Subject: indexing
  10.  
  11. Here's the indexing support I've been working on, if anyone is brave
  12. enough to test it. The shar file has two files -- the tex source and the
  13. beginnings of the documentation.
  14.  
  15. Comments are welcome.
  16.  
  17. #!/bin/sh
  18. #    This is a shell archive.
  19. #    Run the file through sh to extract its contents.
  20. # shar:    Shell Archiver
  21. #    Run the following text with /bin/sh to create:
  22. #    eidx.tex
  23. #    idx.texi
  24. # This archive created: Sat Apr 16 16:19:33 1994
  25. # By:     ()
  26. cat << \SHAR_EOF > eidx.tex
  27. \input eplain
  28. \catcode`@ = 11
  29.  
  30. % The index(es).
  31. % 
  32. % \defineindex{PREFIX} defines an index with ``prefix'' PREFIX.  The
  33. % prefix is used to construct the output filename and the various
  34. % commands.  We just define all the index commands for this index to
  35. % call the general commands with PREFIX.
  36. %
  37. \let\extraidxcmdsuffixes = \empty
  38. %
  39. \outer\def\defineindex#1{%
  40.   \def\@idxprefix{#1}%
  41.   %
  42.   % Define the indexing commands for this prefix. 
  43.   \for\@idxcmd:=,marked,submarked,name%
  44.                 \extraidxcmdsuffixes\do
  45.   {%
  46.     \@defineindexcmd\@idxcmd
  47.   }%
  48.   %
  49.   % Allocate a stream for the output.
  50.   \ece\innernewwrite{@#1indexfile}%
  51.   %
  52.   % And a conditional to test whether we've opened the file.
  53.   \ece\innernewif{if@#1indexfileopened}%
  54. }%
  55. %
  56. %
  57. % \@defineindexcmd{SUFFIX} defines both silent and non-silent index
  58. % command for prefix \@idxprefix with suffix SUFFIX.  That is, we define
  59. % both `\@idxprefix dxSUFFIX' and `\s\@idxprefix dxSUFFIX' to call the
  60. % corresponding generic command with \@idxprefix.  \silentindexentry is
  61. % used to decide whether we should ignore following spaces.
  62. % 
  63. \newif\ifsilentindexentry
  64. %
  65. \def\@defineindexcmd#1{%
  66.   \@defineoneindexcmd{s}{#1}\silentindexentrytrue
  67.   \@defineoneindexcmd{}{#1}\silentindexentryfalse
  68. }%
  69. %
  70. %
  71. % \@defineoneindexcmd{PREFIX}{SUFFIX}{PRECALL} does just one silent or
  72. % non-silent commands.  We define the command `\@@PREFIXidxSUFFIX' to do
  73. % PRECALL, then define \@idxprefix, then call \@idxgetrange with an
  74. % argument of `\@@{,s}idxSUFFIX'.  (So far every indexing command 
  75. % should allow a range.  If not, you could redefine `\@@{,s}idxSUFFIX'
  76. % after this macro is called.)
  77. % 
  78. \def\@defineoneindexcmd#1#2#3{%
  79.   \toks@ = {#3}%
  80.   \edef\temp{%
  81.     \def
  82.       % We have to restrict expansion because the generic (\@@...)
  83.       % commands will be defined after the first call to \defineindex.
  84.       % Not expanding the user (\idx...) commands is unnecessary unless
  85.       % the user has defined some new commands, but may as well be cautious.
  86.       \expandonce\csname#1\@idxprefix dx#2\endcsname % e.g., \idx or \sidxname.
  87.       {\def\noexpand\@idxprefix{\@idxprefix}% define \@idxprefix
  88.        % call, e.g., \@@idx or \@@sidxname:
  89.        \expandonce\csname @@#1idx#2\endcsname
  90.       }%
  91.     \def
  92.       \expandonce\csname @@#1idx#2\endcsname{% e.g., \@@idx
  93.         % First do PRECALL.
  94.         \the\toks@
  95.         % Then call \@idxgetrange with, e.g., \@idx or \@sidxname as its arg.
  96.         \noexpand\@idxgetrange\expandonce\csname @#1idx#2\endcsname
  97.       }%
  98.   }%
  99.   \temp
  100. }%
  101. %
  102. %
  103. % \@idxwrite{TERM}{PAGENO} writes a general index entry for TERM on page
  104. % PAGENO to the index file `\@idxprefix indexfile'.  We open the stream
  105. % as `\indexfilebasename.\@idxprefix dx' if it isn't already open.
  106. %
  107. \let\indexfilebasename = \jobname
  108. %
  109. \def\@idxwrite#1#2{%
  110.   % Be sure the file is opened.
  111.   \csname if@\@idxprefix indexfileopened\endcsname \else
  112.     \expandafter\immediate\openout\csname @\@idxprefix indexfile\endcsname =
  113.       \indexfilebasename.\@idxprefix dx
  114.     \expandafter\global\csname @\@idxprefix indexfileopenedtrue\endcsname
  115.   \fi
  116.   %
  117.   % Save the index term.
  118.   \def\temp{#1}%
  119.   %
  120.   % Write the index term and page number.
  121.   \edef\@wr{%
  122.     \expandafter\write\csname @\@idxprefix indexfile\endcsname{%
  123.       \string\indexentry
  124.       {\sanitize\temp}%
  125.       {\noexpand#2}%
  126.     }%
  127.   }%
  128.   \@wr
  129.   % 
  130.   % Marginalize the index term, if desired.
  131.   \ifindexproofing \insert\@indexproof{\indexproofterm{#1}}\fi
  132.   %
  133.   % We just appended at least one non-discardable item (namely, the
  134.   % whatsit from the \write) to the current list.  So in case glue comes
  135.   % next (not unlikely), be sure we don't inadvertently make that glue a
  136.   % valid breakpoint, if it wouldn't have been without us.
  137.   \hookrun{afterindexterm}%
  138.   %
  139.   % This is the end of the index entry processing.  If this was a silent
  140.   % entry, ignore following spaces.
  141.   \ifsilentindexentry \expandafter\ignorespaces\fi
  142. }%
  143. %
  144. %
  145. % If this conditional is true, we output the index terms on the page
  146. % where they occur.
  147. \newif\ifindexproofing
  148. %
  149. % We need a new insertion class to collect the proofed terms.
  150. \newinsert\@indexproof
  151. \dimen\@indexproof = \maxdimen                  % No limit on number of terms.
  152. \count\@indexproof = 0  \skip\@indexproof = 0pt % They take up no space.
  153. %
  154. % This actually typesets the proofed term.  We don't go to any lengths
  155. % to provide nice-looking output; since the term might have all kinds of
  156. % weird characters in it, we just dump it in the smallest standard
  157. % Computer Modern typewriter font.
  158. % 
  159. % We put the term in an \hbox, even though that might make the output
  160. % run off the page, since we don't really need to see all of it, and
  161. % I think it's better to opt for simplicity -- one term per line.
  162. \font\indexprooffont = cmtt8
  163. \def\indexproofterm#1{\hbox{\strut \indexprooffont #1}}%
  164. %
  165. %
  166. % If \output doesn't use \makeheadline, or redefines it, it's up to the
  167. % new \output to call \indexproofunbox.
  168. \let\@plainmakeheadline = \makeheadline
  169. \def\makeheadline{%
  170.   \ifvoid\@indexproof\else \indexsetmargins \indexproofunbox \fi
  171.   \@plainmakeheadline
  172. }%
  173. %
  174. % We want to put the proof index terms in the margin, outside the
  175. % printed area. So if \outsidemargin (for odd pages) and \insidemargin
  176. % (for even pages) are undefined, we define them (both) to be the default
  177. % TeX margin -- one inch + \hoffset.
  178. \def\indexsetmargins{%
  179.   \ifx\undefined\outsidemargin
  180.     \dimen@ = 1in
  181.     \advance\dimen@ by \hoffset
  182.     \edef\outsidemargin{\the\dimen@}%
  183.     \let\insidemargin = \outsidemargin
  184.   \fi
  185. }%
  186. %
  187. % We always put the terms in the right-hand margin, so long terms run
  188. % off the page, instead of into the text.
  189. \def\indexproofunbox{%
  190.   \rlap{%
  191.     \kern\hsize
  192.     \ifodd\pageno \kern\outsidemargin \else \kern\insidemargin \fi
  193.     \vbox to 0pt{\unvbox\@indexproof\vss}%
  194.   }%
  195. }%
  196. %
  197. %
  198. % \@idxgetrange\CS parses an optional argument which, if present, should
  199. % be either `begin' or `end', marking the beginning or ending of a range
  200. % for the index entry.  If we find this, we set the appropriate one of
  201. % \@idxrangestr.  Then we call \CS.
  202. % 
  203. % If the optional argument is `see' or `seealso' we read another
  204. % argument, namely, the entry to see.
  205. % 
  206. \def\idxrangebeginword{begin}%
  207. \def\idxbeginrangemark{(}% the corresponding magic char to go in the idx file
  208. %
  209. \def\idxrangeendword{end}%
  210. \def\idxendrangemark{)}%
  211. %
  212. \def\idxseecmdword{see}%
  213. \def\idxseealsocmdword{seealso}%
  214. \newif\if@idxsee
  215. \let\@idxseenterm = \relax
  216. %
  217. \def\idxpagemarkupcmdword{pagemarkup}%
  218. \let\@idxpagemarkup = \relax
  219. %
  220. \def\@idxgetrange#1{%
  221.   \let\@idxrangestr = \empty
  222.   \let\@afteridxgetrange = #1%
  223.   \@getoptionalarg\@finidxgetopt
  224. }%
  225. \def\@finidxgetopt{%
  226.   \for\@idxarg:=\@optionalarg\do{%
  227.     % These are ordered by my guess at frequency of use.
  228.     \expandafter\@idxcheckpagemarkup\@idxarg=,%
  229.     %
  230.     \ifx\@idxarg\idxrangebeginword
  231.       \def\@idxrangestr{\idxencapoperator\idxbeginrangemark}%
  232.     \else
  233.       \ifx\@idxarg\idxrangeendword
  234.         \def\@idxrangestr{\idxencapoperator\idxendrangemark}%
  235.       \else
  236.         \ifx\@idxarg\idxseecmdword
  237.           \def\@idxpagemarkup{indexsee}%
  238.           \@idxseetrue
  239.         \else
  240.           \ifx\@idxarg\idxseealsocmdword
  241.             \def\@idxpagemarkup{indexseealso}%
  242.             \@idxseetrue
  243.           \else
  244.              \ifx\@idxpagemarkup\relax
  245.                \errmessage{Unrecognized index option `\@idxarg'}%
  246.              \fi
  247.           \fi
  248.         \fi
  249.       \fi
  250.     \fi
  251.   }%
  252.   \@afteridxgetrange
  253. }%
  254. %
  255. %
  256. % Check for a command of the form `pagemarkup=\cmd', and if found, set
  257. % \@idxpagemarkup to `cmd'.
  258. % 
  259. \def\@idxcheckpagemarkup#1=#2,{%
  260.   \def\temp{#1}%
  261.   \ifx\temp\idxpagemarkupcmdword
  262.     \if ,#2, % If #2 is empty, complain.
  263.       \errmessage{Missing markup command to `pagemarkup'}%
  264.     \else
  265.       % Remove a trailing =.
  266.       \def\temp##1={##1}%
  267.       \edef\@idxpagemarkup{\temp\string#2}%
  268.     \fi
  269.   \fi
  270. }%
  271. %
  272. %
  273. % \@idxtokscollect uses \@idxmaintoks as the token list for the main
  274. % part of an index entry and \@idxsubtoks for the subpart.  Then it
  275. % calls \@idxwrite.
  276. % 
  277. \def\idxsubentryseparator{!}%
  278. \def\idxencapoperator{|}%
  279. \def\idxmaxpagenum{99999}%
  280. %
  281. \newtoks\@idxmaintoks
  282. \newtoks\@idxsubtoks
  283. %
  284. \def\@idxtokscollect{%
  285.   % Remember the subentry.
  286.   \edef\temp{\the\@idxsubtoks}%
  287.   %
  288.   % We want to expand the conditions, but not the terms.  The index
  289.   % entry starts simply with \@idxmaintoks and \@idxsubtoks.
  290.   \edef\@indexentry{%
  291.     \the\@idxmaintoks
  292.     \ifx\temp\empty\else \idxsubentryseparator\the\@idxsubtoks \fi
  293.     \@idxrangestr
  294.   }%
  295.   %
  296.   % If this is a `see' or `see also' entry, we need to read one more
  297.   % arg.  We use a giant page number so the entry will be last (for the
  298.   % benefit of `see also's).  MakeIndex rejects page numbers >=1000.
  299.   % 
  300.   \if@idxsee
  301.     \@idxseefalse % Reset so the next term won't be a `see'.
  302.     \edef\temp{\noexpand\@finidxtokscollect{\idxmaxpagenum}}%
  303.   \else
  304.     \def\temp{\@finfinidxtokscollect\folio}%
  305.   \fi
  306.   \temp
  307. }%
  308. %
  309. %
  310. % \@finidxtokscollect{PAGENO}{REAL-TERM} reads the final term for
  311. % see/see also entries.  We do not check if the person has put both a
  312. % range and a see in the same index term (which will confuse makeindex).
  313. % 
  314. \def\@finidxtokscollect#1#2{%
  315.   \def\@idxseenterm{#2}%
  316.   \@finfinidxtokscollect{#1}%
  317. }%
  318. %
  319. % \@finfinidxtokscollect{PAGENO} writes \@indexentry for page PAGENO.
  320. % Besides \@indexentry, if \@idxpagemarkup is not \relax we output an
  321. % index entry \@indexentry|\@idxpagemarkup{PAGENO}.  And if
  322. % \@idxseenterm is not \relax we output {\@idxseenterm} after the
  323. % \@idxpagemarkup.  (This will become an argument to the ``markup''
  324. % command, which will be \indexsee or \indexseealso.)
  325. % 
  326. \def\@finfinidxtokscollect#1{%
  327.   % If we've got a page markup command, append it.
  328.   \ifx\@idxpagemarkup\relax \else
  329.     \toks@ = \expandafter{\@indexentry}%
  330.     \edef\@indexentry{\the\toks@ \idxencapoperator \@idxpagemarkup}%
  331.     \let\@idxpagemarkup = \relax
  332.   \fi
  333.   %
  334.   % If we've got an argument to the ``page markup'' command, append it.
  335.   \ifx\@idxseenterm\relax \else
  336.     \toks@ = \expandafter{\@indexentry}%
  337.     \edef\@indexentry{\the\toks@{\sanitize\@idxseenterm}}%
  338.     \let\@idxseenterm = \relax
  339.   \fi
  340.   %
  341.   % Finally, write what we've constructed.
  342.   \expandafter\@idxwrite\expandafter{\@indexentry}{#1}%
  343. }%
  344. %
  345. %
  346. % \@idxcollect{MAIN}{SUB} sets up the token registers
  347. % \@idx{main,sub}toks, then calls \@idxtokscollect.  This is convenient
  348. % for some of the macros below.
  349. % 
  350. \def\@idxcollect#1#2{%
  351.   \@idxmaintoks = {#1}%
  352.   \@idxsubtoks = {#2}%
  353.   \@idxtokscollect
  354. }%
  355. %
  356. %
  357. % Following are the TeX macros that correspond to the commands
  358. % that actually appear in the document.
  359. %
  360. % \@idx{TERM} produces TERM in the output and then makes the index entry
  361. % for TERM as usual.  We don't allow a [SUBTERM] here since then we
  362. % would lose spaces after the command, which would be very inconvenient.
  363. %
  364. % As with all our index commands, we've already defined \@idxprefix (in
  365. % \idx or whatever), to save passing it around, and we've looked for a
  366. % range argument before TERM.
  367. % 
  368. \def\@idx#1{%
  369.   #1% Produce TERM as output.
  370.   \@idxcollect{#1}{}%
  371. }%
  372. %
  373. % \@sidx{TERM}[SUBTERM] produces an index entry TERM and no output.  If
  374. % SUBTERM is present, this is a subentry.  (At the moment, I don't
  375. % provide for subsubentries, since I've never needed that.)
  376. % 
  377. \def\@sidx#1{\@idxmaintoks = {#1}\@getoptionalarg\@finsidx}%
  378. \def\@finsidx{%
  379.   \@idxsubtoks = \expandafter{\@optionalarg}%
  380.   \@idxtokscollect
  381. }%
  382. %
  383. %
  384. % \@idxconstructmarked{TOKS-REG}\CS{TERM}
  385. % 
  386. \def\idxsortkeysep{@}% This `@' is catcode 11, but it doesn't matter.
  387. %
  388. \def\@idxconstructmarked#1#2#3{%
  389.   \toks@ = {#2}% The control sequence.
  390.   \toks2 = {#3}% The term.
  391.   %
  392.   % Construct TERM@\CS{TERM} as the string to write.
  393.   \edef\temp{\the\toks2 \idxsortkeysep \the\toks@{\the\toks2}}%
  394.   %
  395.   % Save it in TOKS-REG.
  396.   #1 = \expandafter{\temp}%
  397. }%
  398. %
  399. %
  400. % \@idxmarked\CS{TERM} outputs \CS{TERM} and then calls the main part of
  401. % \@sidxmarked.
  402. %
  403. \def\@idxmarked#1#2{%
  404.   #1{#2}% Produce \CS{TERM} as output.
  405.   \@idxconstructmarked\@idxmaintoks{#1}{#2}%
  406.   \@idxsubtoks = {}%
  407.   \@idxtokscollect
  408. }%
  409. %
  410. % \@sidxmarked\CS{TERM}[SUBTERM] outputs an index entry sorted by TERM
  411. % but producing \CS{TERM}.
  412. % 
  413. \def\@sidxmarked#1#2{%
  414.   \@idxconstructmarked\toks@{#1}{#2}%
  415.   \edef\temp{{\the\toks@}}%
  416.   \expandafter\@sidx\temp
  417. }%
  418. %
  419. %
  420. % \@idxsubmarked{TERM}\CS{SUBTERM} is like \@idxmarked, except that it's
  421. % SUBTERM that's marked instead of TERM.
  422. % 
  423. \def\@idxsubmarked#1#2#3{%
  424.   #1 #2{#3}% produce `TERM \CS{SUBTERM} as output.
  425.   \@sidxsubmarked{#1}{#2}{#3}%
  426. }%
  427. %
  428. % \@sidxsubmarked{TERM}\CS{SUBTERM} is to \@sidxmarked as \@idxsubmarked
  429. % is to \@idxmarked.
  430. % 
  431. \def\@sidxsubmarked#1#2#3{%
  432.   \@idxmaintoks = {#1}%
  433.   \@idxconstructmarked\@idxsubtoks{#2}{#3}%
  434.   \@idxtokscollect
  435. }%
  436. %
  437. %
  438. % \@idxcollectname{FIRST}{LAST} puts `LAST, FIRST' into \temp. (Well,
  439. % we use \idxnameseparator instead of hardwiring `, '.) If FIRST is
  440. % empty, don't include the separator.
  441. % 
  442. \def\idxnameseparator{, }% as in `Tachikawa, Elizabeth'
  443. %
  444. \def\@idxcollectname#1#2{%
  445.   \def\temp{#1}%
  446.   \ifx\temp\empty
  447.     \toks@ = {}%
  448.   \else
  449.     \toks@ = {\idxnameseparator #1}%
  450.   \fi
  451.   \toks2 = {#2}%
  452.   %
  453.   \edef\temp{\the\toks2 \the\toks@}%
  454. }%
  455. %
  456. %
  457. % \@idxname{FIRST}{LAST} also produces `FIRST LAST' in the output and an
  458. % index entry for `LAST, FIRST'.
  459. %
  460. \def\@idxname#1#2{%
  461.   #1 #2% Separate the names by a space in the output.
  462.   \@idxcollectname{#1}{#2}%
  463.   \expandafter\@idxcollect\expandafter{\temp}{}%
  464. }%
  465. %
  466. % \@sidxname{FIRST}{LAST}[SUBTERM] is to \@sidx as \@idxname is to
  467. % \@idx.
  468. % 
  469. \def\@sidxname#1#2{%
  470.   \@idxcollectname{#1}{#2}%
  471.   \expandafter\@sidx\expandafter{\temp}%
  472. }%
  473. %
  474. %
  475. % Now we come to actually producing the index, i.e., implementing the
  476. % formatting commands that MakeIndex outputs.
  477. %
  478. % \readindexfile is responsible for formatting and printing the index.
  479. % It reads \indexfilebasename.ind.  We implement the same commands that
  480. % LaTeX does.  I suppose we could allow for different indices having
  481. % different basenames, but I can't imagine when that would be useful.
  482. % 
  483. \let\indexfonts = \relax
  484. \def\readindexfile#1{%
  485.   \edef\@idxprefix{#1}%
  486.   %
  487.   % Does the output file exist?
  488.   \testfileexistence[\indexfilebasename]{\@idxprefix nd}%
  489.   \iffileexists \begingroup
  490.     \indexfonts
  491.     %
  492.     % If no \begin or \end, define them. The argument will be `{theindex}'.
  493.     \ifx\begin\undefined
  494.       \def\begin##1{\@beginindex}%
  495.       \let\end = \@gobble
  496.     \fi
  497.     %
  498.     % Set up the default formatting:
  499.     \doublecolumns
  500.     \parindent = 0pt
  501.     %
  502.     % Let the user override the defaults.
  503.     \hookrun{beginindex}%
  504.     %
  505.     % Read the file:
  506.     \input \indexfilebasename.\@idxprefix nd
  507.     % 
  508.     % \doublecolumns isn't affected by groups.
  509.     \singlecolumn
  510.   \endgroup
  511.   \else
  512.     \message{No index file \indexfilebasename.\@idxprefix nd.}%
  513.   \fi
  514. }%
  515. %
  516. % Here's the default for `\begin{theindex}', if \begin isn't defined.
  517. \def\@beginindex{%
  518.   \let\item = \@indexitem
  519.   \let\subitem = \@indexsubitem
  520.   \let\subsubitem = \@indexsubsubitem
  521. }%
  522. %
  523. % \indexspace appears between groups in the ind file.
  524. \let\indexspace = \bigbreak
  525. %
  526. % You can make \afterindexterm appear after the term and before the
  527. % first page with the following in the ist file:
  528. % delim_0 "\\afterindexterm "
  529. % delim_1 "\\afterindexterm "
  530. % delim_2 "\\afterindexterm "
  531. \let\afterindexterm = \quad
  532. %
  533. %
  534. % Top-level index entries start with \item.
  535. \newskip\aboveindexitemskipamount  \aboveindexitemskipamount = 0pt plus2pt
  536. \def\aboveindexitemskip{\vskip\aboveindexitemskipamount}%
  537. %
  538. \def\@indexitem{\begingroup
  539.   \@indexitemsetup
  540.   \leftskip = 0pt
  541.   \aboveindexitemskip
  542.   \penalty-100 % Encourage page breaks before items.
  543.   % 
  544.   % But forbid page breaks after items, in case a subitem follows.
  545.   \def\par{\endgraf\endgroup\nobreak}%
  546. }%
  547. %
  548. % Secondary index entries.
  549. \def\@indexsubitem{%
  550.   \@indexitemsetup
  551.   \leftskip = 1em
  552. }%
  553. %
  554. % And tertiary entries.
  555. \def\@indexsubsubitem{%
  556.   \@indexitemsetup
  557.   \leftskip = 2em
  558. }%
  559. %
  560. % Common setup for the formatting.
  561. \def\@indexitemsetup{%
  562.   \par
  563.   \hangindent = 1em
  564.   \raggedright
  565.   \hyphenpenalty = 10000
  566.   \hookrun{indexitem}%
  567. }%
  568. %
  569. %
  570. % \indexsee{TERM}{PAGENO} ignores PAGENO, and says `See TERM'.
  571. \def\seevariant{\it}%
  572. \def\indexseeword{See}%
  573. \def\indexsee#1#2{{\seevariant \indexseeword\ }#1}%
  574. %
  575. % \indexseealso{TERM}{PAGENO} is similar.
  576. \def\indexseealsowords{see also}%
  577. \def\indexseealso#1#2{{\seevariant \indexseealsowords\ }#1}%
  578. %
  579. %
  580. % We provide one index by default; commands are \idx, \sidx, etc.
  581. \defineindex{i}%
  582. SHAR_EOF
  583. cat << \SHAR_EOF > idx.texi
  584. @node Indexing
  585. @section Indexing
  586.  
  587. @cindex indexing
  588. @cindex sorting an index
  589. @pindex makeindex
  590.  
  591. Eplain provides support for generating raw material for an index, and
  592. for typesetting a sorted index. A separate program must do the actual
  593. collection and sorting of terms, because @TeX{} itself has no support
  594. for sorting. Eplain's indexing commands work with the program MakeIndex,
  595. available by ftp from @samp{ftp.math.utah.edu} in
  596. @file{pub/tex/makeindex}, and from the CTAN hosts in
  597. @file{tex-archive/indexing/makeindex}; MakeIndex is also commonly
  598. included in prepackaged @TeX{} distributions.
  599.  
  600. The basic strategy for indexing works like this:
  601.  
  602. @enumerate
  603.  
  604. @pindex .idx @r{files}
  605. @item For a document @file{foo.tex}, Eplain's indexing commands (e.g.,
  606. @code{\idx}; see the section `Indexing terms' below) write the raw index
  607. material to @file{foo.idx}.
  608.  
  609. @pindex .ind @r{files}
  610. @item MakeIndex reads @file{foo.idx}, collects and sorts the index, and
  611. writes the result to @file{foo.ind}. 
  612.  
  613. @item Eplain reads and typesets @file{foo.ind} on the next run of @TeX{}.
  614.  
  615. @end enumerate
  616.  
  617. @cindex multiple indices
  618. @cindex indices, multiple
  619. @findex defineindex
  620. If your document needs more than one index, each must naturally have a
  621. separate file. Therefore, Eplain provides the command
  622. @code{\defineindex}, which takes an argument that is a single letter,
  623. which replaces @samp{i} in the filenames and in the indexing command
  624. names described below. For example,
  625.  
  626. @example
  627. \defineindex@{m@}
  628. @end example
  629.  
  630. @noindent will define the command @code{\mdx} to write to the file
  631. @file{foo.mdx}. Eplain simply does @code{\defineindex@{i@}} to define
  632. the default commands.
  633.  
  634. @menu
  635. * Indexing commands::        Specifying what to index.
  636. * MakeIndex interaction::    MakeIndex conventions followed by Eplain.
  637. * Typesetting an index::    Printing the sorted output.
  638. @end menu
  639.  
  640.  
  641. @node Indexing commands
  642. @subsection Indexing commands
  643.  
  644. @cindex indexing terms
  645. @cindex indexing
  646.  
  647. \idx{term}
  648. \sidx{term}[subterm]
  649. \idxmarked\defn{term}
  650. \sidxmarked\defn{term}[subterm]
  651. \idxsubmarked{term}\defn{subterm}
  652. \sidxsubmarked{term}\defn{subterm}
  653. \idxname{First}{Last}
  654. \sidxname{First}{Last}[subterm]
  655. \idxnameseparator
  656.  
  657. \extraidxcmdsuffixes
  658.  
  659. \hookaction{afterindexterm}
  660.  
  661. \idxbeginrangemark [begin] -> (
  662. \idxendrangemark [end]   -> )
  663. \indexseeword [see]
  664. \indexseealsoword [seealso]
  665. [pagemarkup=defn]
  666.  
  667. \idx{Ap-weight@$A_p$-weight}
  668.  
  669. @menu
  670. * Proofing index terms::    Noting index entries where they're made.
  671. @end menu
  672.  
  673.  
  674. @node
  675. @subsubsection Proofing index terms
  676.  
  677. \indexproofing{true,false}
  678.   \indexsetmargins
  679.     \outsidemargin
  680.     \insidemargin
  681.   \indexproofunbox
  682.  
  683.  
  684. @node
  685. @subsection MakeIndex interaction
  686.  
  687. \idxsubentryseparator
  688. \idxencapoperator
  689. \idxmaxpagenum
  690.  
  691. \afterindexterm
  692.  
  693. \item
  694. \subitem
  695. \subsubitem
  696.  
  697.  
  698. @node Typesetting an index
  699. @subsection Typesetting an index
  700.  
  701. \readindexfile{i}
  702.   \indexfilebasename
  703.   \indexfonts
  704.   \begin{theindex}...\end{theindex}
  705.   \hookaction{beginindex}
  706.   
  707.   \aboveindexitemskip{,amount}
  708.   \hookaction{indexitem}
  709.   \indexspace
  710. SHAR_EOF
  711. #    End of shell archive
  712. exit 0